<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>tuple - ClueLib</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/prettify.js"></script></head><body class="FramedContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>

<!--  Generated by Natural Docs, version 1.52 -->
<!--  http://www.naturaldocs.org  -->

<!-- saved from url=(0026)http://www.naturaldocs.org -->




<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="tuple"></a>tuple</h1><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>class tuple#(</td><td class="PType  prettyprint " nowrap>type&nbsp;</td><td class="PParameter  prettyprint " nowrap>T1</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> int,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>type&nbsp;</td><td class="PParameter  prettyprint " nowrap>T2</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> int,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>type&nbsp;</td><td class="PParameter  prettyprint " nowrap>T3</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> int,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>type&nbsp;</td><td class="PParameter  prettyprint " nowrap>T4</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> int,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>type&nbsp;</td><td class="PParameter  prettyprint " nowrap>T5</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> int,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>type&nbsp;</td><td class="PParameter  prettyprint " nowrap>T6</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> int,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>type&nbsp;</td><td class="PParameter  prettyprint " nowrap>T7</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> int,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>type&nbsp;</td><td class="PParameter  prettyprint " nowrap>T8</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> int,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>type&nbsp;</td><td class="PParameter  prettyprint " nowrap>T9</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> int,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>type&nbsp;</td><td class="PParameter  prettyprint " nowrap>T10</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> int</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Provides a tuple that carries up to ten values, which can be different types.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>T1</td><td class=CDLDescription><span class="optional">optional</span> The type of the first value of a tuple.&nbsp; The default is <b>int</b>.</td></tr><tr><td class=CDLEntry>T2</td><td class=CDLDescription><span class="optional">optional</span> The type of the second value of a tuple.&nbsp; The default is <b>int</b>.</td></tr><tr><td class=CDLEntry>T3</td><td class=CDLDescription><span class="optional">optional</span> The type of the third value of a tuple.&nbsp; The default is <b>int</b>.</td></tr><tr><td class=CDLEntry>T4</td><td class=CDLDescription><span class="optional">optional</span> The type of the fourth value of a tuple.&nbsp; The default is <b>int</b>.</td></tr><tr><td class=CDLEntry>T5</td><td class=CDLDescription><span class="optional">optional</span> The type of the fifth value of a tuple.&nbsp; The default is <b>int</b>.</td></tr><tr><td class=CDLEntry>T6</td><td class=CDLDescription><span class="optional">optional</span> The type of the sixth value of a tuple.&nbsp; The default is <b>int</b>.</td></tr><tr><td class=CDLEntry>T7</td><td class=CDLDescription><span class="optional">optional</span> The type of the seventh value of a tuple.&nbsp; The default is <b>int</b>.</td></tr><tr><td class=CDLEntry>T8</td><td class=CDLDescription><span class="optional">optional</span> The type of the eighth value of a tuple.&nbsp; The default is <b>int</b>.</td></tr><tr><td class=CDLEntry>T9</td><td class=CDLDescription><span class="optional">optional</span> The type of the ninth value of a tuple.&nbsp; The default is <b>int</b>.</td></tr><tr><td class=CDLEntry>T10</td><td class=CDLDescription><span class="optional">optional</span> The type of the tenth value of a tuple.&nbsp; The default is <b>int</b>.</td></tr></table><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#tuple" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">tuple</a></td><td class=SDescription>Provides a tuple that carries up to ten values, which can be different types.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#tuple.Types" >Types</a></td><td class=SDescription></td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#tuple.this_type" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">this_type</a></td><td class=SDescription>The shorthand of <b>tuple#(T1,T2,T3,T4,T5,T6,T7,T8,T9,T10)</b></td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#tuple.Properties" >Properties</a></td><td class=SDescription></td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#tuple.first" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">first</a></td><td class=SDescription>The first value inside the tuple.</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#tuple.second" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">second</a></td><td class=SDescription>The second value inside the tuple.</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#tuple.third" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">third</a></td><td class=SDescription>The third value inside the tuple.</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#tuple.fourth" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">fourth</a></td><td class=SDescription>The fourth value inside the tuple.</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#tuple.fifth" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">fifth</a></td><td class=SDescription>The fifth value inside the tuple.</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#tuple.sixth" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">sixth</a></td><td class=SDescription>The sixth value inside the tuple.</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#tuple.seventh" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">seventh</a></td><td class=SDescription>The seventh value inside the tuple.</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#tuple.eighth" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">eighth</a></td><td class=SDescription>The eighth value inside the tuple.</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#tuple.ninth" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">ninth</a></td><td class=SDescription>The ninth value inside the tuple.</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#tuple.tenth" id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')">tenth</a></td><td class=SDescription>The tenth value inside the tuple.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#tuple.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#tuple.new" id=link13 onMouseOver="ShowTip(event, 'tt13', 'link13')" onMouseOut="HideTip('tt13')">new</a></td><td class=SDescription>Creates a tuple of values of types T1, T2, and T3. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#tuple.eq" id=link14 onMouseOver="ShowTip(event, 'tt14', 'link14')" onMouseOut="HideTip('tt14')">eq</a></td><td class=SDescription>Returns 1 if this object is equal to the specified tuple. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#tuple.ne" id=link15 onMouseOver="ShowTip(event, 'tt15', 'link15')" onMouseOut="HideTip('tt15')">ne</a></td><td class=SDescription>Returns 1 if this object is not equal to the specified tuple. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#tuple.lt" id=link16 onMouseOver="ShowTip(event, 'tt16', 'link16')" onMouseOut="HideTip('tt16')">lt</a></td><td class=SDescription>Returns 1 if this object is less than the specified tuple. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#tuple.gt" id=link17 onMouseOver="ShowTip(event, 'tt17', 'link17')" onMouseOut="HideTip('tt17')">gt</a></td><td class=SDescription>Returns 1 if this object is greater than the specified tuple. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#tuple.le" id=link18 onMouseOver="ShowTip(event, 'tt18', 'link18')" onMouseOut="HideTip('tt18')">le</a></td><td class=SDescription>Returns 1 if this object is less than or equal to the specified tuple. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#tuple.ge" id=link19 onMouseOver="ShowTip(event, 'tt19', 'link19')" onMouseOut="HideTip('tt19')">ge</a></td><td class=SDescription>Returns 1 if this object is greater than or equal to the specified tuple. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#tuple.clone" id=link20 onMouseOver="ShowTip(event, 'tt20', 'link20')" onMouseOut="HideTip('tt20')">clone</a></td><td class=SDescription>Creates a tuple by cloning this object.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#tuple.swap" id=link21 onMouseOver="ShowTip(event, 'tt21', 'link21')" onMouseOut="HideTip('tt21')">swap</a></td><td class=SDescription>Swaps the contents of this tuple with the ones of the specified tuple.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="tuple.Types"></a>Types</h3></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="tuple.this_type"></a>this_type</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>typedef tuple#(</td><td class="PParameter  prettyprint " nowrap>T1,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>T2,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>T3,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>T4,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>T5,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>T6,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>T7,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>T8,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>T9,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>T10</td><td class="PAfterParameters  prettyprint "nowrap>) this_type</td></tr></table></td></tr></table></blockquote><p>The shorthand of <b>tuple#(T1,T2,T3,T4,T5,T6,T7,T8,T9,T10)</b></p></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="tuple.Properties"></a>Properties</h3></div></div>

<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="tuple.first"></a>first</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">T1 first</td></tr></table></blockquote><p>The first value inside the tuple.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">tuple#(int,string,bit[7:0]) t = new( 1, &quot;apple&quot;, 8'hFF );
assert( t.first == 1 );</pre></blockquote></div></div></div>

<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="tuple.second"></a>second</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">T2 second</td></tr></table></blockquote><p>The second value inside the tuple.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">tuple#(int,string,bit[7:0]) t = new( 1, &quot;apple&quot;, 8'hFF );
assert( t.second == &quot;apple&quot; );</pre></blockquote></div></div></div>

<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="tuple.third"></a>third</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">T3 third</td></tr></table></blockquote><p>The third value inside the tuple.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">tuple#(int,string,bit[7:0]) t = new( 1, &quot;apple&quot;, 8'hFF );
assert( t.third == 8'hFF );</pre></blockquote></div></div></div>

<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="tuple.fourth"></a>fourth</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">T4 fourth</td></tr></table></blockquote><p>The fourth value inside the tuple.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">tuple#() t = new( 1, 2, 3, 4 );
assert( t.fourth == 4 );</pre></blockquote></div></div></div>

<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="tuple.fifth"></a>fifth</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">T5 fifth</td></tr></table></blockquote><p>The fifth value inside the tuple.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">tuple#() t = new( 1, 2, 3, 4, 5 );
assert( t.fifth == 5 );</pre></blockquote></div></div></div>

<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="tuple.sixth"></a>sixth</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">T6 sixth</td></tr></table></blockquote><p>The sixth value inside the tuple.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">tuple#() t = new( 1, 2, 3, 4, 5, 6 );
assert( t.sixth == 6 );</pre></blockquote></div></div></div>

<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="tuple.seventh"></a>seventh</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">T7 seventh</td></tr></table></blockquote><p>The seventh value inside the tuple.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">tuple#() t = new( 1, 2, 3, 4, 5, 6, 7 );
assert( t.seventh == 7 );</pre></blockquote></div></div></div>

<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="tuple.eighth"></a>eighth</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">T8 eighth</td></tr></table></blockquote><p>The eighth value inside the tuple.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">tuple#() t = new( 1, 2, 3, 4, 5, 6, 7, 8 );
assert( t.eighth == 8 );</pre></blockquote></div></div></div>

<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="tuple.ninth"></a>ninth</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">T9 ninth</td></tr></table></blockquote><p>The ninth value inside the tuple.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">tuple#() t = new( 1, 2, 3, 4, 5, 6, 7, 8, 9 );
assert( t.ninth == 9 );</pre></blockquote></div></div></div>

<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="tuple.tenth"></a>tenth</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">T10 tenth</td></tr></table></blockquote><p>The tenth value inside the tuple.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">tuple#() t = new( 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 );
assert( t.tenth == 10 );</pre></blockquote></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="tuple.Functions"></a>Functions</h3></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="tuple.new"></a>new</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>function new(</td><td class="PType  prettyprint " nowrap>T1&nbsp;</td><td class="PParameter  prettyprint " nowrap>first,</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%></td></tr><tr><td></td><td class="PType  prettyprint " nowrap>T2&nbsp;</td><td class="PParameter  prettyprint " nowrap>second,</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%></td></tr><tr><td></td><td class="PType  prettyprint " nowrap>T3&nbsp;</td><td class="PParameter  prettyprint " nowrap>third,</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%></td></tr><tr><td></td><td class="PType  prettyprint " nowrap>T4&nbsp;</td><td class="PParameter  prettyprint " nowrap>fourth</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> 0,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>T5&nbsp;</td><td class="PParameter  prettyprint " nowrap>fifth</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> 0,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>T6&nbsp;</td><td class="PParameter  prettyprint " nowrap>sixth</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> 0,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>T7&nbsp;</td><td class="PParameter  prettyprint " nowrap>seventh</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> 0,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>T8&nbsp;</td><td class="PParameter  prettyprint " nowrap>eighth</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> 0,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>T9&nbsp;</td><td class="PParameter  prettyprint " nowrap>ninth</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> 0,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>T10&nbsp;</td><td class="PParameter  prettyprint " nowrap>tenth</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> 0,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>comparator#(this_type)&nbsp;</td><td class="PParameter  prettyprint " nowrap>cmp</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> null</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Creates a tuple of values of types T1, T2, and T3.&nbsp; Optionally, a tuple can have up to ten values of different types.</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>first</td><td class=CDLDescription>The first  value of a tuple.</td></tr><tr><td class=CDLEntry>second</td><td class=CDLDescription>The second value of a tuple.</td></tr><tr><td class=CDLEntry>third</td><td class=CDLDescription>The third  value of a tuple.</td></tr><tr><td class=CDLEntry>fourth</td><td class=CDLDescription><span class="optional">optional</span> The fourth  value of a tuple.</td></tr><tr><td class=CDLEntry>fifth</td><td class=CDLDescription><span class="optional">optional</span> The fifth   value of a tuple.</td></tr><tr><td class=CDLEntry>sixth</td><td class=CDLDescription><span class="optional">optional</span> The sixth   value of a tuple.</td></tr><tr><td class=CDLEntry>seventh</td><td class=CDLDescription><span class="optional">optional</span> The seventh value of a tuple.</td></tr><tr><td class=CDLEntry>eighth</td><td class=CDLDescription><span class="optional">optional</span> The eighth  value of a tuple.</td></tr><tr><td class=CDLEntry>ninth</td><td class=CDLDescription><span class="optional">optional</span> The ninth   value of a tuple.</td></tr><tr><td class=CDLEntry>tenth</td><td class=CDLDescription><span class="optional">optional</span> The tenth   value of a tuple.</td></tr><tr><td class=CDLEntry>cmp</td><td class=CDLDescription><span class="optional">optional</span> A strategy object used to compare two tuples.&nbsp; If not specified or <b>null</b>, <a href="cl_tuple_comparator-svh.html#tuple_comparator" class=LClass id=link22 onMouseOver="ShowTip(event, 'tt22', 'link22')" onMouseOut="HideTip('tt22')">tuple_comparator</a> <b>#(this_type)</b> is used.&nbsp; The default is <b>null</b>.</td></tr></table><h4 class=CHeading>Returns</h4><p>None.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">tuple#(int, string, bit[7:0]) t = new( 1, &quot;apple&quot;, 8'hFF );</pre></blockquote></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="tuple.eq"></a>eq</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>function bit eq(</td><td class="PTypePrefix  prettyprint " nowrap>const ref&nbsp;</td><td class="PType  prettyprint " nowrap>this_type&nbsp;</td><td class="PParameter  prettyprint " nowrap>t</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns 1 if this object is equal to the specified tuple.&nbsp; The comparison is done by the strategy object specified at the object construction.</p><h4 class=CHeading>Argument</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>t</td><td class=CDLDescription>A tuple to compare with.</td></tr></table><h4 class=CHeading>Returns</h4><p>If this object is equal to <b>t</b>, then returns 1.&nbsp; Otherwise, returns 0.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">tuple#(int, string, bit[7:0]) t = new( 1, &quot;apple&quot;, 8'hFF );
tuple#(int, string, bit[7:0]) u = new( 1, &quot;apple&quot;, 8'hFF );
assert( t.eq( u ) == 1 ); // 1 == 1 &amp;&amp; &quot;apple&quot; == &quot;apple&quot; &amp;&amp; 8'hFF == 8'hFF</pre></blockquote></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="tuple.ne"></a>ne</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>function bit ne(</td><td class="PTypePrefix  prettyprint " nowrap>const ref&nbsp;</td><td class="PType  prettyprint " nowrap>this_type&nbsp;</td><td class="PParameter  prettyprint " nowrap>t</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns 1 if this object is not equal to the specified tuple.&nbsp; The comparison is done by the strategy object specified at the object construction.</p><h4 class=CHeading>Argument</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>t</td><td class=CDLDescription>A tuple to compare with.</td></tr></table><h4 class=CHeading>Returns</h4><p>If this object is not equal to <b>t</b>, then returns 1.&nbsp; Otherwise, returns 0.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">tuple#(int, string, bit[7:0]) t = new( 1, &quot;apple&quot;,  8'hFF );
tuple#(int, string, bit[7:0]) u = new( 1, &quot;orange&quot;, 8'hFF );
assert( t.ne( u ) == 1 ); // &quot;apple&quot; != &quot;orange&quot;</pre></blockquote></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="tuple.lt"></a>lt</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>function bit lt(</td><td class="PTypePrefix  prettyprint " nowrap>const ref&nbsp;</td><td class="PType  prettyprint " nowrap>this_type&nbsp;</td><td class="PParameter  prettyprint " nowrap>t</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns 1 if this object is less than the specified tuple.&nbsp; The comparison is done by the strategy object specified at the object construction.</p><h4 class=CHeading>Argument</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>t</td><td class=CDLDescription>A tuple to compare with.</td></tr></table><h4 class=CHeading>Returns</h4><p>If this object is less than <b>t</b>, then returns 1.&nbsp; Otherwise, returns 0.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">tuple#(int, string, bit[7:0]) t = new( 1, &quot;apple&quot;, 8'hFF );
tuple#(int, string, bit[7:0]) u = new( 2, &quot;apple&quot;, 8'hFF );
assert( t.lt( u ) == 1 ); // 1 &lt; 2</pre></blockquote></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="tuple.gt"></a>gt</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>function bit gt(</td><td class="PTypePrefix  prettyprint " nowrap>const ref&nbsp;</td><td class="PType  prettyprint " nowrap>this_type&nbsp;</td><td class="PParameter  prettyprint " nowrap>t</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns 1 if this object is greater than the specified tuple.&nbsp; The comparison is done by the strategy object specified at the object construction.</p><h4 class=CHeading>Argument</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>t</td><td class=CDLDescription>A tuple to compare with.</td></tr></table><h4 class=CHeading>Returns</h4><p>If this object is greater than <b>t</b>, then returns 1.&nbsp; Otherwise, returns 0.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">tuple#(int, string, bit[7:0]) t = new( 1, &quot;orange&quot;, 8'hFF );
tuple#(int, string, bit[7:0]) u = new( 1, &quot;apple&quot;,  8'hFF );
assert( t.gt( u ) == 1 ); // &quot;orange&quot; &gt; &quot;apple&quot; by the lexicographical order</pre></blockquote></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="tuple.le"></a>le</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>function bit le(</td><td class="PTypePrefix  prettyprint " nowrap>const ref&nbsp;</td><td class="PType  prettyprint " nowrap>this_type&nbsp;</td><td class="PParameter  prettyprint " nowrap>t</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns 1 if this object is less than or equal to the specified tuple.&nbsp; The comparison is done by the strategy object specified at the object construction.</p><h4 class=CHeading>Argument</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>t</td><td class=CDLDescription>A tuple to compare with.</td></tr></table><h4 class=CHeading>Returns</h4><p>If this object is less than or equal to <b>t</b>, then returns 1.&nbsp; Otherwise, returns 0.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">tuple#(int, string, bit[7:0]) t = new( 1, &quot;apple&quot;,  8'hFF );
tuple#(int, string, bit[7:0]) u = new( 1, &quot;orange&quot;, 8'hFF );
assert( t.le( u ) == 1 ); // &quot;apple&quot; &lt; &quot;orange&quot; by the lexicographical order</pre></blockquote></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="tuple.ge"></a>ge</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>function bit ge(</td><td class="PTypePrefix  prettyprint " nowrap>const ref&nbsp;</td><td class="PType  prettyprint " nowrap>this_type&nbsp;</td><td class="PParameter  prettyprint " nowrap>t</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns 1 if this object is greater than or equal to the specified tuple.&nbsp; The comparison is done by the strategy object specified at the object construction.</p><h4 class=CHeading>Argument</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>t</td><td class=CDLDescription>A tuple to compare with.</td></tr></table><h4 class=CHeading>Returns</h4><p>If this object is greater than or equal to <b>t</b>, then returns 1.&nbsp; Otherwise, returns 0.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">tuple#(int, string, bit[7:0]) t = new( 2, &quot;apple&quot;,  8'hFF );
tuple#(int, string, bit[7:0]) u = new( 1, &quot;orange&quot;, 8'hFF );
assert( t.ge( u ) == 1 ); // 2 &gt; 1</pre></blockquote></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="tuple.clone"></a>clone</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function this_type clone()</td></tr></table></blockquote><p>Creates a tuple by cloning this object.</p><h4 class=CHeading>Returns</h4><p>A cloned tuple.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">tuple#(int, string, bit[7:0]) t = new( 1, &quot;apple&quot;,  8'hFF );
tuple#(int, string, bit[7:0]) u = t.clone();
assert( t.eq( u ) == 1 );</pre></blockquote></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="tuple.swap"></a>swap</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>function void swap(</td><td class="PTypePrefix  prettyprint " nowrap>ref&nbsp;</td><td class="PType  prettyprint " nowrap>this_type&nbsp;</td><td class="PParameter  prettyprint " nowrap>t</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Swaps the contents of this tuple with the ones of the specified tuple.</p><h4 class=CHeading>Argument</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>t</td><td class=CDLDescription>A tuple to swap the contents.</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">tuple#(int, string, bit[7:0]) t = new( 1, &quot;apple&quot;,  8'hFF );
tuple#(int, string, bit[7:0]) u = new( 2, &quot;orange&quot;, 8'hAA );
t.swap( u );
assert( t.first == 2 );
assert( u.first == 1 );
assert( t.second == &quot;orange&quot; );
assert( u.second == &quot;apple&quot; );
assert( t.third == 8'hAA );
assert( u.third == 8'hFF );</pre></blockquote></div></div></div>

</div><!--Content-->



<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CClass><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>class tuple#(</td><td class="PType  prettyprint " nowrap>type&nbsp;</td><td class="PParameter  prettyprint " nowrap>T1</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> int,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>type&nbsp;</td><td class="PParameter  prettyprint " nowrap>T2</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> int,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>type&nbsp;</td><td class="PParameter  prettyprint " nowrap>T3</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> int,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>type&nbsp;</td><td class="PParameter  prettyprint " nowrap>T4</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> int,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>type&nbsp;</td><td class="PParameter  prettyprint " nowrap>T5</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> int,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>type&nbsp;</td><td class="PParameter  prettyprint " nowrap>T6</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> int,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>type&nbsp;</td><td class="PParameter  prettyprint " nowrap>T7</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> int,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>type&nbsp;</td><td class="PParameter  prettyprint " nowrap>T8</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> int,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>type&nbsp;</td><td class="PParameter  prettyprint " nowrap>T9</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> int,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>type&nbsp;</td><td class="PParameter  prettyprint " nowrap>T10</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> int</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Provides a tuple that carries up to ten values, which can be different types.</div></div><div class=CToolTip id="tt2"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>typedef tuple#(</td><td class="PParameter  prettyprint " nowrap>T1,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>T2,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>T3,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>T4,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>T5,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>T6,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>T7,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>T8,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>T9,</td></tr><tr><td></td><td class="PParameter  prettyprint " nowrap>T10</td><td class="PAfterParameters  prettyprint "nowrap>) this_type</td></tr></table></td></tr></table></blockquote>The shorthand of <b>tuple#(T1,T2,T3,T4,T5,T6,T7,T8,T9,T10)</b></div></div><div class=CToolTip id="tt3"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">T1 first</td></tr></table></blockquote>The first value inside the tuple.</div></div><div class=CToolTip id="tt4"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">T2 second</td></tr></table></blockquote>The second value inside the tuple.</div></div><div class=CToolTip id="tt5"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">T3 third</td></tr></table></blockquote>The third value inside the tuple.</div></div><div class=CToolTip id="tt6"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">T4 fourth</td></tr></table></blockquote>The fourth value inside the tuple.</div></div><div class=CToolTip id="tt7"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">T5 fifth</td></tr></table></blockquote>The fifth value inside the tuple.</div></div><div class=CToolTip id="tt8"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">T6 sixth</td></tr></table></blockquote>The sixth value inside the tuple.</div></div><div class=CToolTip id="tt9"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">T7 seventh</td></tr></table></blockquote>The seventh value inside the tuple.</div></div><div class=CToolTip id="tt10"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">T8 eighth</td></tr></table></blockquote>The eighth value inside the tuple.</div></div><div class=CToolTip id="tt11"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">T9 ninth</td></tr></table></blockquote>The ninth value inside the tuple.</div></div><div class=CToolTip id="tt12"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">T10 tenth</td></tr></table></blockquote>The tenth value inside the tuple.</div></div><div class=CToolTip id="tt13"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>function new(</td><td class="PType  prettyprint " nowrap>T1&nbsp;</td><td class="PParameter  prettyprint " nowrap>first,</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%></td></tr><tr><td></td><td class="PType  prettyprint " nowrap>T2&nbsp;</td><td class="PParameter  prettyprint " nowrap>second,</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%></td></tr><tr><td></td><td class="PType  prettyprint " nowrap>T3&nbsp;</td><td class="PParameter  prettyprint " nowrap>third,</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%></td></tr><tr><td></td><td class="PType  prettyprint " nowrap>T4&nbsp;</td><td class="PParameter  prettyprint " nowrap>fourth</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> 0,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>T5&nbsp;</td><td class="PParameter  prettyprint " nowrap>fifth</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> 0,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>T6&nbsp;</td><td class="PParameter  prettyprint " nowrap>sixth</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> 0,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>T7&nbsp;</td><td class="PParameter  prettyprint " nowrap>seventh</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> 0,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>T8&nbsp;</td><td class="PParameter  prettyprint " nowrap>eighth</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> 0,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>T9&nbsp;</td><td class="PParameter  prettyprint " nowrap>ninth</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> 0,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>T10&nbsp;</td><td class="PParameter  prettyprint " nowrap>tenth</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> 0,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>comparator#(this_type)&nbsp;</td><td class="PParameter  prettyprint " nowrap>cmp</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> null</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Creates a tuple of values of types T1, T2, and T3. </div></div><div class=CToolTip id="tt14"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>function bit eq(</td><td class="PTypePrefix  prettyprint " nowrap>const ref&nbsp;</td><td class="PType  prettyprint " nowrap>this_type&nbsp;</td><td class="PParameter  prettyprint " nowrap>t</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Returns 1 if this object is equal to the specified tuple. </div></div><div class=CToolTip id="tt15"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>function bit ne(</td><td class="PTypePrefix  prettyprint " nowrap>const ref&nbsp;</td><td class="PType  prettyprint " nowrap>this_type&nbsp;</td><td class="PParameter  prettyprint " nowrap>t</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Returns 1 if this object is not equal to the specified tuple. </div></div><div class=CToolTip id="tt16"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>function bit lt(</td><td class="PTypePrefix  prettyprint " nowrap>const ref&nbsp;</td><td class="PType  prettyprint " nowrap>this_type&nbsp;</td><td class="PParameter  prettyprint " nowrap>t</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Returns 1 if this object is less than the specified tuple. </div></div><div class=CToolTip id="tt17"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>function bit gt(</td><td class="PTypePrefix  prettyprint " nowrap>const ref&nbsp;</td><td class="PType  prettyprint " nowrap>this_type&nbsp;</td><td class="PParameter  prettyprint " nowrap>t</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Returns 1 if this object is greater than the specified tuple. </div></div><div class=CToolTip id="tt18"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>function bit le(</td><td class="PTypePrefix  prettyprint " nowrap>const ref&nbsp;</td><td class="PType  prettyprint " nowrap>this_type&nbsp;</td><td class="PParameter  prettyprint " nowrap>t</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Returns 1 if this object is less than or equal to the specified tuple. </div></div><div class=CToolTip id="tt19"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>function bit ge(</td><td class="PTypePrefix  prettyprint " nowrap>const ref&nbsp;</td><td class="PType  prettyprint " nowrap>this_type&nbsp;</td><td class="PParameter  prettyprint " nowrap>t</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Returns 1 if this object is greater than or equal to the specified tuple. </div></div><div class=CToolTip id="tt20"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function this_type clone()</td></tr></table></blockquote>Creates a tuple by cloning this object.</div></div><div class=CToolTip id="tt21"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>function void swap(</td><td class="PTypePrefix  prettyprint " nowrap>ref&nbsp;</td><td class="PType  prettyprint " nowrap>this_type&nbsp;</td><td class="PParameter  prettyprint " nowrap>t</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Swaps the contents of this tuple with the ones of the specified tuple.</div></div><div class=CToolTip id="tt22"><div class=CClass><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>class tuple_comparator#(</td><td class="PType  prettyprint " nowrap>type&nbsp;</td><td class="PParameter  prettyprint " nowrap>T</td><td class="PDefaultValuePrefix  prettyprint ">&nbsp;=&nbsp;</td><td class="PDefaultValue  prettyprint " width=100%> tuple</td><td class="PAfterParameters  prettyprint "nowrap>) extends comparator#(T)</td></tr></table></td></tr></table></blockquote><span class="singleton">singleton</span> Provides strategies to compare tuples.</div></div><!--END_ND_TOOLTIPS-->

<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>